FCU.h

Go to the documentation of this file.

#ifndef FCU_H_
#define FCU_H_

/*
 **************************************************************
 * Defines, Macros and Typedefs 
 **************************************************************/
/*** Constant Macros ***/
/* Default Yes and No defines */
#ifndef TRUE
 #define TRUE (1u)
#endif
#ifndef CLEAR
 #define CLEAR (0u)
#endif
#ifndef BITS_IN_NIBBLE
 #define BITS_IN_NIBBLE (4u)
#endif
#ifndef BITS_IN_BYTE
 #define BITS_IN_BYTE (8u)
#endif
#ifndef BYTES_IN_16
 #define BYTES_IN_16  (2u)
#endif
#ifndef BYTES_IN_32
 #define BYTES_IN_32  (4u)
#endif

#ifndef BIT_DEFINITION
 #define BIT_DEFINITION
 #define BIT0  (1u << 0u)
 #define BIT1  (1u << 1u)
 #define BIT2  (1u << 2u)
 #define BIT3  (1u << 3u)
 #define BIT4  (1u << 4u)
 #define BIT5  (1u << 5u)
 #define BIT6  (1u << 6u)
 #define BIT7  (1u << 7u)
 #define BIT8  (1u << 8u)
 #define BIT9  (1u << 9u)
 #define BIT10 (1u << 10)
 #define BIT11 (1u << 11)
 #define BIT12 (1u << 12)
 #define BIT13 (1u << 13)
 #define BIT14 (1u << 14)
 #define BIT15 (1u << 15)
 #define BIT16 (1u << 16)
 #define BIT17 (1u << 17)
 #define BIT18 (1u << 18)
 #define BIT19 (1u << 19)
 #define BIT20 (1u << 20)
 #define BIT21 (1u << 21)
 #define BIT22 (1u << 22)
 #define BIT23 (1u << 23)
 #define BIT24 (1u << 24)
 #define BIT25 (1u << 25)
 #define BIT26 (1u << 26)
 #define BIT27 (1u << 27)
 #define BIT28 (1u << 28)
 #define BIT29 (1u << 29)
 #define BIT30 (1u << 30)
 #define BIT31 (1u << 31)
#endif

/* HW Status masks */
/* for module status */
#define FCU_IS_IN_INIT   (0x01u)
#define FCU_IS_NORMAL    (0x02u)
#define FCU_IS_ALARMED   (0x04u)
#define FCU_IS_AT_FAULT  (0x08u)

/* Error status bits */
#define FCU_LOCKED (0x10u)

/* for fault interpretation */
#define FCU_CORE_CHECKSTOP_MODE_ENTERED BIT0
#define FCU_CORE_RESET BIT1
#define FCU_LOSS_OF_XTAL BIT2
#define FCU_LOSS_OF_PLL0_LOCK BIT3
#define FCU_FREQ0_OUT_OF_RANGE BIT4
#define FCU_LOSS_OF_PLL1_LOCK BIT5
#define FCU_FREQ1_OUT_OF_RANGE BIT6
#define FCU_FLASH_FATAL_ERROR BIT7
#define FCU_WATCHDOG_RESET    BIT8
#define FCU_JTAG_RESET        BIT9
#define FCU_POWER_COMPARATOR_ERROR BIT10
#define FCU_LVD_4_5                BIT11
#define FCU_LVD_2_7_VREG           BIT12
#define FCU_LVD_2_7_FLASH          BIT13
#define FCU_LVD_2_7_I_0            BIT14
#define FCU_LVD_1_2_DIG            BIT15

#define FCU_ERROR                  BIT31
#define FCU_SW_TRIGGERED_ERROR     BIT30
#define FCU_CODE_FLASH_ECC_ERROR   BIT29
#define FCU_DATA_FLASH_ECC_ERROR   BIT28
#define FCU_SRAM_ECC_ERROR         BIT27
#define FCU_CONFIG_ERROR                  BIT7
#define FCU_CONFIG_SW_TRIGGERED_ERROR     BIT6
#define FCU_CONFIG_CODE_FLASH_ECC_ERROR   BIT5
#define FCU_CONFIG_DATA_FLASH_ECC_ERROR   BIT4
#define FCU_CONFIG_SRAM_ECC_ERROR         BIT3

/* For time-out */
#define FCU_4MS_TIMEOUT 0xFFFFu

/*** Function Macros ***/
#ifndef N_ELEMENTS
 #define N_ELEMENTS(X)           (sizeof(X)/sizeof(*(X)))
#endif

/* [0] */
#define FCU_TIMEOUT(XX)           (XX)
/* [1] */
#define FCU_TES0_ENABLED          (0x80000000u)
#define FCU_TES0_DISABLED         (0x00000000u)
#define FCU_TES1_ENABLED          (0x40000000u)
#define FCU_TES1_DISABLED         (0x00000000u)
#define FCU_TES2_ENABLED          (0x20000000u)
#define FCU_TES2_DISABLED         (0x00000000u)
#define FCU_TES3_ENABLED          (0x10000000u)
#define FCU_TES3_DISABLED         (0x00000000u)
#define FCU_TES4_ENABLED          (0x08000000u)
#define FCU_TES4_DISABLED         (0x00000000u)
#define FCU_ESF0_ENABLED          (0x00800000u)
#define FCU_ESF0_DISABLED         (0x00000000u)
#define FCU_ESF1_ENABLED          (0x00400000u)
#define FCU_ESF1_DISABLED         (0x00000000u)
#define FCU_ESF2_ENABLED          (0x00200000u)
#define FCU_ESF2_DISABLED         (0x00000000u)
#define FCU_ESF3_ENABLED          (0x00100000u)
#define FCU_ESF3_DISABLED         (0x00000000u)
#define FCU_ESF4_ENABLED          (0x00080000u)
#define FCU_ESF4_DISABLED         (0x00000000u)
#define FCU_ENABLE_CH(XX)         ((XX))
/* [2] */
#define FCU_TIMEOUT_CH(XX)        ((XX) << 16u)
#define FCU_NO_TEST_MODE         0x00u
#define FCU_TEST_MODE_NO_PINS    0x400u
#define FCU_TEST_MODE_WITH_PINS  0x800u
#define FCU_OUTPUT_POL_NORMAL    0x0U
#define FCU_OUTPUT0_INV_POL      0x100u
#define FCU_OUTPUT1_INV_POL      0x200u
#define FCU_OUTPUT_INV_POL       0x300u
#define FCU_OUTPUT_IS_DUAL_RAIL   0u
#define FCU_OUTPUT_IS_TIME_SWITCH 0x40u
#define FCU_OUTPUT_IS_BISTABLE    0x80u
#define FCU_OUTPUT_FREQ(XX)       ((XX) & 0x7u)

/*** Enums ***/


/*** TypeDefs ***/
typedef union
{
  struct
  {
    vuint32_t Timeout; /* [0] Timeout value for alarm */
    vuint8_t TES0: 1; /* [1] Enable time-out for software */
    vuint8_t TES1: 1; /* [1] Enable time-out for software */
    vuint8_t TES2: 1; /* [1] Enable time-out for software */
    vuint8_t TES3: 1; /* [1] Enable time-out for software */
    vuint8_t TES4: 1; /* [1] Enable time-out for software */
    vuint8_t Reserved3: 3; /* [1] */
    vuint8_t ESF0: 1; /* [1] Enable Software flag */
    vuint8_t ESF1: 1; /* [1] Enable Software flag */
    vuint8_t ESF2: 1; /* [1] Enable Software flag */
    vuint8_t ESF3: 1; /* [1] Enable Software flag */
    vuint8_t ESF4: 1; /* [1] Enable Software flag */
    vuint8_t Resevered2: 3; /* [1] */
    vuint16_t HardwareEnable; /* [1] Enable Hardware flag */
    vuint16_t TEH; /* [2] Enable time-out for hardware */ 
    vuint8_t Reserved: 4; /* [2] */
    vuint8_t TM:  2; /* [2] Test Mode */
    vuint8_t PS:  2; /* [2] Polarity Switch */
    vuint8_t FOM: 2; /* [2] Fault Output Mode */
    vuint8_t FOP: 6; /* [2] Fault Output Prescaler */
  }P;
  
  vuint32_t A[3u];
} FCUConfig_t;

/*
 **************************************************************
 * Declarations 
 **************************************************************/
/*** Global ***/
/*** Static ***/

/*** Constant ***/
/*
 **************************************************************
 * Function Prototypes 
 **************************************************************/
/*
 ******************************************************************************
 *
 * Function:          u8fnFCUInit()
 *
 */
uint8_t u8fnFCUInit(FCUConfig_t* ptMyConfig);
/*
 ******************************************************************************
 *
 * Function:          u8fnFCUEnableConfig()
 *
 */
uint8_t u8fnFCUEnableConfig(void);
/*
 ******************************************************************************
 *
 * Function:          u8fnFCUSMStatus()
 *
 */
uint8_t u8fnFCUSMStatus(void);
#endif /* FCU_H_ */